home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / lib / perl5 / Glib / Utils.pod < prev    next >
Text File  |  2009-04-29  |  4KB  |  214 lines

  1. =head1 NAME
  2.  
  3. Glib::Utils -  Miscellaneous utility functions
  4.  
  5. =cut
  6.  
  7. =for position SYNOPSIS
  8.  
  9. =head1 SYNOPSIS
  10.  
  11.   use Glib;
  12.   Glib::set_application_name (Glib::get_real_name."'s Cool Program");
  13.  
  14.   print "app name is ".Glib::get_application_name()."\n";
  15.  
  16. =for position DESCRIPTION
  17.  
  18. =head1 DESCRIPTION
  19.  
  20. Here are some useful miscellaneous utilities.
  21. GLib is a portability library, providing portable utility functions for
  22. C programs.  As such, most of these functions seem to violate the Glib
  23. binding principle of not duplicating functionality that Perl already
  24. provides, but there's a distinction for each one, i swear.  The functions
  25. for dealing with user information are provided on all GLib-supported
  26. platforms, not just where POSIX (which provides similar information) is
  27. available, and even work on platforms where %ENV may not include the
  28. expected information.  Also, the "application name" referred to by
  29. (set|get)_application_name is a human readable name, distinct from the
  30. actual program name provided by Perl's own $0.
  31.  
  32. =cut
  33.  
  34.  
  35.  
  36. =for object Glib::Utils Miscellaneous utility functions
  37. =cut
  38.  
  39.  
  40.  
  41.  
  42. =head1 METHODS
  43.  
  44. =head2 string = Glib::get_application_name 
  45.  
  46. Get the human-readable application name set by C<set_application_name>.
  47.  
  48. Since: glib 2.2
  49.  
  50. =head2 Glib::set_application_name ($application_name)
  51.  
  52. =over
  53.  
  54. =item * $application_name (string) 
  55.  
  56. =back
  57.  
  58. Set the human-readable application name.
  59.  
  60. Since: glib 2.2
  61.  
  62. =head2 string = Glib::get_home_dir 
  63.  
  64. Find the current user's home directory, by system-dependent/appropriate
  65. means.
  66.  
  67. =head2 list = Glib::get_language_names 
  68.  
  69. Computes a list of applicable locale names, which can be used to e.g. construct
  70. locale-dependent filenames or search paths. The returned list is sorted from
  71. most desirable to least desirable and always contains the default locale "C".
  72.  
  73. Since: glib 2.6
  74.  
  75. =head2 string = Glib::get_real_name 
  76.  
  77. Get the current user's real name.
  78.  
  79. =head2 string = Glib::strerror ($err)
  80.  
  81. =over
  82.  
  83. =item * $err (integer) 
  84.  
  85. =back
  86.  
  87. Return a string describing the given errno value, like "No such file
  88. or directory" for ENOENT.  This is translated into the user's
  89. preferred language and is a utf8 wide-char string (unlike a $!
  90. string (L<perlvar>) or POSIX::strerror (L<POSIX>) which are locale
  91. codeset bytes).
  92.  
  93. =head2 string = Glib::strsignal ($signum)
  94.  
  95. =over
  96.  
  97. =item * $signum (integer) 
  98.  
  99. =back
  100.  
  101. Return a string describing the given signal number, like "Segmentation
  102. violation" for SIGSEGV.  This is translated into the user's preferred
  103. language and is a utf8 wide-char string.
  104.  
  105. =head2 list = Glib::get_system_config_dirs 
  106.  
  107. Returns an ordered list of base directories in which to access system-wide
  108. configuration information.
  109.  
  110. Since: glib 2.6
  111.  
  112. =head2 list = Glib::get_system_data_dirs 
  113.  
  114. Returns an ordered list of base directories in which to access system-wide
  115. application data.
  116.  
  117. Since: glib 2.6
  118.  
  119. =head2 string = Glib::get_tmp_dir 
  120.  
  121. Get the temp dir as appropriate for the current system.  See the GLib docs
  122. for info on how it works.
  123.  
  124. =head2 string = Glib::get_user_cache_dir 
  125.  
  126. Gets the base directory in which to store non-essential, cached data specific
  127. to particular user.
  128.  
  129. Since: glib 2.6
  130.  
  131. =head2 string = Glib::get_user_config_dir 
  132.  
  133. Gets the base directory in which to store user-specific application
  134. configuration information such as user preferences and settings.
  135.  
  136. Since: glib 2.6
  137.  
  138. =head2 string = Glib::get_user_data_dir 
  139.  
  140. Get the base directory for application data such as icons that is customized
  141. for a particular user.
  142.  
  143. Since: glib 2.6
  144.  
  145. =head2 string = Glib::get_user_name 
  146.  
  147. Get the current user's name by whatever system-dependent means necessary.
  148.  
  149. =head2 string = Glib::get_user_special_dir ($directory)
  150.  
  151. =over
  152.  
  153. =item * $directory (Glib::UserDirectory) 
  154.  
  155. =back
  156.  
  157. Returns the full path of a special directory using its logical id.
  158.  
  159. Since: glib 2.14
  160.  
  161.  
  162.  
  163. =cut
  164.  
  165.  
  166. =head1 ENUMS AND FLAGS
  167.  
  168. =head2 enum Glib::UserDirectory
  169.  
  170. =over
  171.  
  172. =item * 'desktop' / 'G_USER_DIRECTORY_DESKTOP'
  173.  
  174. =item * 'documents' / 'G_USER_DIRECTORY_DOCUMENTS'
  175.  
  176. =item * 'download' / 'G_USER_DIRECTORY_DOWNLOAD'
  177.  
  178. =item * 'music' / 'G_USER_DIRECTORY_MUSIC'
  179.  
  180. =item * 'pictures' / 'G_USER_DIRECTORY_PICTURES'
  181.  
  182. =item * 'public-share' / 'G_USER_DIRECTORY_PUBLIC_SHARE'
  183.  
  184. =item * 'templates' / 'G_USER_DIRECTORY_TEMPLATES'
  185.  
  186. =item * 'videos' / 'G_USER_DIRECTORY_VIDEOS'
  187.  
  188. =back
  189.  
  190.  
  191.  
  192.  
  193. =cut
  194.  
  195.  
  196. =head1 SEE ALSO
  197.  
  198. L<Glib>
  199.  
  200.  
  201. =cut
  202.  
  203.  
  204. =head1 COPYRIGHT
  205.  
  206. Copyright (C) 2003-2009 by the gtk2-perl team.
  207.  
  208. This software is licensed under the LGPL.  See L<Glib> for a full notice.
  209.  
  210.  
  211.  
  212. =cut
  213.  
  214.